All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class quicktime.std.music.TunePlayer

java.lang.Object
   |
   +----quicktime.QTObject
           |
           +----quicktime.std.comp.ComponentIdentifier
                   |
                   +----quicktime.std.comp.Component
                           |
                           +----quicktime.std.music.TunePlayer

public final class TunePlayer

extends Component

implements QuickTimeLib

TunePlayer()

Opens the TunePlayer component.

fromMusicMediaHandler(MusicMediaHandler, int)

Returns the TunePlayer that is responsible for rendering the music data that is contained within a particular music track.

getIndexedNoteChannel(int)

Returns the note channel at the specified index.

getNoteAllocator()

Returns the NoteAllocator that the tune player is using.

getNumberOfNoteChannels()

Returns the number of note channels that the tune player is using.

getPartMix(int)

Returns the current state of a part in a mix, its volume, balance, and mute/solo state.

getStatus()

Returns an initialised structure describing the state of the tune player.

getTimeBase()

Returns the TunePlayer's current time Base.

getTimeScale()

Returns the current time scale of the tune player, in units-per-second.

getVolume()

Returns the volume of the sequence.

instant(TuneStatus, int)

Play the sequence of music events at a specified position.

preroll()

Prepares the tune player by attempting to reserve note channels for each part in the sequence.

queue(MusicData, float, int, int, int)

Places a sequence of music events into a queue to be played.

setBalance(int)

Modifies the pan controller setting for a tune player.

setHeader(MusicData)

Prepares the tune player to accept subsequent music event sequences by defining one or more parts to be used by sequence Note events.

setHeaderWithSize(MusicData, int)

Prepares the tune player to accept subsequence music events by defining one or more parts to be used.

setNoteChannels(NoteChannel[])

Prepares the tune player to accept music event sequences by allocating specified note channels for them.

setPartMix(int, float, float, int)

Alters the volume and the balance of the specified part, with the flags specifying special conditions.

setPartTranspose(int, float, int)

Modifies the pitch and velocity of every note of the specified part of a tune.

setSofter(boolean)

Adjusts the volume to play at a generally softer value that was the normal value for QT 2_1, otherwise sets the volume to a normal level.

setSoundLocalization(SoundLocalization)

Passes sound localisation data to the tune player.

setTimeScale(int)

Sets the time scale used by the tune player.

setVolume(float)

Sets the volume for the entire sequence.

stop()

Stops a currently playing sequence.

task()

Call this method periodically to allow the tune player to perform tasks it must perform at foreground task time.

unroll()

Releases any note channels that may have been allocated by previous calls to preroll.

 public TunePlayer() throws QTException

Opens the TunePlayer component.

QuickTime::OpenADefaultComponent

 public static TunePlayer fromMusicMediaHandler(MusicMediaHandler mh,
                                                int index) throws StdQTException

Returns the TunePlayer that is responsible for rendering the music data that is contained within a particular music track. If the movie or this media is edited in any way then the returned TunePlayer becomes invalid and must be got again.

QuickTime::MusicMediaGetIndexedTunePlayer()

Parameters:

index - the index within the media.

See Also:

getIndexedTunePlayer

 public void setHeader(MusicData header) throws StdQTException

Prepares the tune player to accept subsequent music event sequences by defining one or more parts to be used by sequence Note events.

QuickTime::TuneSetHeader

Parameters:

header - the tune header data

 public TimeBase getTimeBase() throws StdQTException

Returns the TunePlayer's current time Base.

QuickTime::TuneGetTimeBase

Returns:

the TimeBase

 public void setTimeScale(int scale) throws StdQTException

Sets the time scale used by the tune player.

QuickTime::TuneSetTimeScale

Parameters:

scale - the new scale

 public int getTimeScale() throws StdQTException

Returns the current time scale of the tune player, in units-per-second.

QuickTime::TuneGetTimeScale

Returns:

the current scale

 public int getNumberOfNoteChannels() throws StdQTException

Returns the number of note channels that the tune player is using.

QuickTime::TuneGetIndexedNoteChannel

Returns:

the number of note channels

 public NoteChannel getIndexedNoteChannel(int index) throws StdQTException

Returns the note channel at the specified index.

QuickTime::TuneGetIndexedNoteChannel

Parameters:

index - the part for which you want the note channel

Returns:

the note channel

 public void queue(MusicData tune,
                   float tuneRate,
                   int tuneStartPosition,
                   int tuneStopPosition,
                   int queueFlags) throws StdQTException

Places a sequence of music events into a queue to be played.

QuickTime::TuneQueue

Parameters:

tune - the events to be played

tuneRate - the playback rate at which to play the events

tuneStartPosition - sequence starting time

tuneStopPosition - sequence ending time

queue - flags with details about how to play the queued tune events.

 public void instant(TuneStatus tune,
                     int tunePosition) throws StdQTException

Play the sequence of music events at a specified position.

QuickTime::TuneInstant

Parameters:

tune - the tune data is contained within the TuneStatus object

tunePosition - the position within tune sequence data in time units

 public TuneStatus getStatus() throws StdQTException

Returns an initialised structure describing the state of the tune player.

QuickTime::TuneGetStatus

Returns:

a tune status object

 public void stop() throws StdQTException

Stops a currently playing sequence.

QuickTime::TuneStop

 public void setVolume(float volume) throws StdQTException

Sets the volume for the entire sequence.

QuickTime::TuneSetVolume

Parameters:

volume - the new volume

 public float getVolume() throws StdQTException

Returns the volume of the sequence.

QuickTime::TuneGetVolume

Returns:

the current volume

 public void preroll() throws StdQTException

Prepares the tune player by attempting to reserve note channels for each part in the sequence.

QuickTime::TunePreroll

 public void unroll() throws StdQTException

Releases any note channels that may have been allocated by previous calls to preroll.

QuickTime::TuneUnroll

 public void setNoteChannels(NoteChannel noteChannelList[]) throws StdQTException

Prepares the tune player to accept music event sequences by allocating specified note channels for them.

QuickTime::TuneSetNoteChannels

Parameters:

noteChannelList - the note channels to be set for the tune player

 public void setPartTranspose(int part,
                              float transpose,
                              int velocityShift) throws StdQTException

Modifies the pitch and velocity of every note of the specified part of a tune.

QuickTime::TuneSetPartTranspose

Parameters:

part - the part number for which you want the pitch and velocity changed

transpose - the value by which to modify the pitch of the note - can specify fractional tuning

velocityShift - a value to add to the velocity of each note played

 public NoteAllocator getNoteAllocator()

Returns the NoteAllocator that the tune player is using.

QuickTime::TuneGetNoteAllocator

Returns:

the note allocator

 public void setSofter(boolean softer) throws StdQTException

Adjusts the volume to play at a generally softer value that was the normal value for QT 2_1, otherwise sets the volume to a normal level.

QuickTime::TuneSetSofter

Parameters:

softer - if true it sets the overall volume to a softer level, if false sets it to normal

 public void task() throws StdQTException

Call this method periodically to allow the tune player to perform tasks it must perform at foreground task time.

QuickTime::TuneTask

 public void setBalance(int balance) throws StdQTException

Modifies the pan controller setting for a tune player.

QuickTime::TuneSetBalance

Parameters:

balance - the new balance setting: range is -128 (left) to 127 (right)

 public void setSoundLocalization(SoundLocalization data) throws StdQTException

Passes sound localisation data to the tune player.

QuickTime::TuneSetSoundLocalization

Parameters:

data - the sound localisation data

 public void setHeaderWithSize(MusicData header,
                               int size) throws StdQTException

Prepares the tune player to accept subsequence music events by defining one or more parts to be used. You specify the end of the header with the size parameter so that the parsing will not overflow if there is no end marker.

QuickTime::TuneSetHeaderWithSize

Parameters:

header - a list of general events

size - the size of the header in bytes

 public void setPartMix(int partNumber,
                        float volume,
                        float balance,
                        int mixFlags) throws StdQTException

Alters the volume and the balance of the specified part, with the flags specifying special conditions.

QuickTime::TuneSetPartMix

Parameters:

partNumber - the part to effect

volume - the new volume of the specified part

balance - the new balance of the specified part

mixFlags - the mix flags that will apply to that part - mute or solo part.

 public MixStateInfo getPartMix(int partNumber) throws StdQTException

Returns the current state of a part in a mix, its volume, balance, and mute/solo state.

QuickTime::TuneGetPartMix

Parameters:

partNumber - the part number you require information about

Returns:

the mix state of a part

All Packages  Class Hierarchy  This Package  Previous  Next  Index